'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
.\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH KRB5-CONFIG 1 "June 20, 2021"
.SH NAME
krb5-config \- link against the installed Kerberos libraries
.SH SYNOPSIS
.nf
\fBkrb5-config\fR
     [\fB--all\fR | \fB--cflags\fR | \fB--exec-prefix\fR | \fB--help\fR | \fB--libs\fR \fIlibrary\fR |
      \fB--prefix\fR | \fB--vendor\fR | \fB--version\fR]
.fi

.SH DESCRIPTION
\fBkrb5-config\fR identifies and displays the special flags that are needed to
compile and link programs against the installed Kerberos libraries.
.SH OPTIONS
The following options are supported:
.sp
.ne 2
.na
\fB\fB--all\fR\fR
.ad
.RS 18n
Displays the version, vendor, prefix and \fBexec-prefix\fR.
.RE

.sp
.ne 2
.na
\fB\fB--cflags\fR\fR
.ad
.RS 18n
Displays the compiler flags with which Kerberos was built.
.RE

.sp
.ne 2
.na
\fB\fB--exec-prefix\fR\fR
.ad
.RS 18n
Displays the \fBexec-prefix\fR with which Kerberos was built.
.RE

.sp
.ne 2
.na
\fB\fB--help\fR\fR
.ad
.RS 18n
Displays the usage message.
.sp
This is the default.
.RE

.sp
.ne 2
.na
\fB\fB--libs\fR \fIlibrary\fR\fR
.ad
.RS 18n
Displays compiler options required to link with \fIlibrary\fR.
.sp
The following \fIlibrary\fR values are supported:
.sp
.ne 2
.na
\fB\fBkrb5\fR\fR
.ad
.RS 8n
Kerberos 5 application
.RE

.RE

.sp
.ne 2
.na
\fB\fB--prefix\fR\fR
.ad
.RS 18n
Displays the prefix with which Kerberos was built.
.RE

.sp
.ne 2
.na
\fB\fB--vendor\fR\fR
.ad
.RS 18n
Displays the vendor of the installed Kerberos implementation.
.RE

.sp
.ne 2
.na
\fB\fB--version\fR\fR
.ad
.RS 18n
Displays the version of the installed Kerberos implementation.
.RE

.SH EXAMPLES
\fBExample 1 \fRUsing the \fB--cflags\fR Option
.sp
.LP
The following example displays the C compiler flags needed to use
\fBlibkrb5\fR(3LIB):

.sp
.in +2
.nf
% krb5-config --cflags
-I/usr/include/kerberosv5
.fi
.in -2
.sp

.LP
\fBExample 2 \fRUsing the \fB--libs\fR Option
.sp
.LP
The following example shows the C compiler options needed to link against
\fBlibkrb5\fR(3LIB):

.sp
.in +2
.nf
% krb5-config --libs
-L/usr/lib -R/usr/lib -lkrb5
.fi
.in -2
.sp

.SH EXIT STATUS
The following exit values are returned:
.sp
.ne 2
.na
\fB\fB0\fR\fR
.ad
.RS 6n
Successful completion.
.RE

.sp
.ne 2
.na
\fB>\fB0\fR\fR
.ad
.RS 6n
An error occurred.
.RE

.SH ATTRIBUTES
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Volatile
.TE

.SH SEE ALSO
.BR libgss (3LIB),
.BR libkrb5 (3LIB),
.BR attributes (7)
